home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / pc / PNC-ATL1.ZIP / ATLANTIS.DOC < prev    next >
Encoding:
Text File  |  1997-02-10  |  9.8 KB  |  227 lines
  1. -----------------------------------------------------------------------------
  2.                 ATLANTIS v1.0 - Copyright (c) 1996 Jolly Roger
  3.  
  4.                         Documentation, February 1997 
  5. -----------------------------------------------------------------------------
  6.  
  7.   Okay, Okay.. I Admit.. it's been a VERY long time that I released a
  8.   PPE. This is due to some personal reasons. As you can see, my PPE's
  9.   are no longer from COWS. I've joined Pinnacle to make the group even
  10.   better then they were.
  11.  
  12.   This program is a replacement for the internal menu system of PCBoard.
  13.   It'll turn your menu in a lightbar-driven menu. With a lot of features
  14.   discussed later in this documentation. This PPE is probably the best
  15.   replacement you could ever want for your mainmenu.
  16.   
  17.   After a lot of beta-testing, version 1.0 is finally here. I  know  this
  18.   isn't my most original program, but after Menu/X I knew that I could do
  19.   a lot better.  If you are still using Menu/X I advise you to replace it
  20.   with Atlantis since a lot of bugs have been removed and there are quite
  21.   a few more nice options.
  22.  
  23.   The  configuration  is  very easy and  almost the same  as Menu/X v1.xx.
  24.   However there are  some changes. YOU CAN'T USE THE SAME CONFIGURATION !
  25.   I'll advise you to take a look at the main  configuration  file and
  26.   the seperate CONFIG?\Configration Files.
  27.  
  28. -[ DISCLAIMER ]--------------------------------------------------------------
  29.  
  30.   This software and manual are supplied "AS IS". The author hereby
  31.   disclaims all warranties relating to this software and its
  32.   documentation file, express or implied, including but not limited
  33.   to damage to hardware, software and/or data from use of this
  34.   product. In no event will the author of this software be liable
  35.   to you or any other party for any damages. Your use of this
  36.   software indicates that you have read and agree to these and
  37.   other terms included in this documentation file.
  38.  
  39. -[ FEATURES ]----------------------------------------------------------------
  40.  
  41.   ■ Mainmenu replacement PPE.
  42.   ■ 99,9% configurable..
  43.   ■ ANSI and ASCII.
  44.   ■ Random Menu's. (If selected)
  45.   ■ Totally configurable Menu's, including commandline color.
  46.   ■ Different Menu's for different Security Levels.
  47.   ■ Commands can be given by lightbar and standard commandline.
  48.   ■ Rumours/Taglines, seperate PPE included in the package.
  49.   ■ Seperate Expert Mode/Normal mode.
  50.   ■ Support for BROADCAST'ed messages using MBMS v1.0.
  51.   ■ MBMS, Multinode-Broadcast-Messaging-System v1.0
  52.     Copyright (c) 1997 - Jolly Roger.
  53.   ■ Special SYSOP-Only menu integrated within the PPE.
  54.     This option is secured with a Password and a Security Level and
  55.     started by typing: SYSOP - followed by ENTER :)
  56.   ■ Keeps track of history commands, accessible through PGUP and PGDN.
  57.   ■ Multinode support.
  58.   ■ And much, MUCH more..
  59.  
  60. -[ INSTALLATION ]------------------------------------------------------------
  61.  
  62.   ■  Unzip the package with the "-D" option.
  63.  
  64.   ■  Replace the BRDS and BRDM files in the X:PCB\GEN\ directory with the
  65.      ones supplied in this package. (Yes! The size is 3 bytes)
  66.      Don't worry about Sysop Functions, you can start the sysop menu
  67.      by typing: SYSOP, Password: SECRET (Default, Change in Atlantis.CFG)
  68.  
  69.      NOTE: MAKE A BACKUP COPY FIRST !!
  70.      (In case you think the program sucks and want to restore the original)
  71.  
  72.   ■  Replace PCBTEXT prompt 396 with '!<ppepath>\atlantis.ppe'.
  73.  
  74.   ■  Edit Atlantis.CFG
  75.  
  76.   ■  If you don't like the standard menu, you can configure it to your
  77.      need. Supplied are 4 examples.
  78.  
  79.   ■  Adding Rumours:
  80.      - Start PCBSETUP - B - B - CMD.LST - F2 
  81.      - Add: RUMOUR.PPE (eg: '!<ppepath>\atlantis\rumour\rumour.ppe'.
  82.  
  83.      NOTE: The rumours must be in ATLANTIS\RUMOUR\.. !!
  84.  
  85. -[ CONFIGRATION ]------------------------------------------------------------
  86.  
  87.   ■ Atlantis.CFG is explained in the file!
  88.  
  89.   ■ Config?\Menu*.CFG Explained...
  90.     This is all probably very obvious, but what the heck..
  91.     NOTE: Each item gets his own PIN number.
  92.           (= Personal Identification Number)
  93.  
  94.     UserCommandX=          'The Commandline X position.
  95.     UserCommandY=          'The Commandline Y position.
  96.     DisplayConference=     'Should the PPE display the current conference?
  97.     ConferenceX=           'If so, the X Position.
  98.     ConferenceY=           'If so, the Y Position.
  99.     ConferenceColor=       'If so, the color to be used.
  100.     DisplayTimeLeft=       'Should the PPE display the minutes left?
  101.     TimeLeftX=             'If so, the X Position.
  102.     TimeLeftY=             'If so, the Y Position.
  103.     TimeLeftColor=         'If so, the color to be used.
  104.     FirstHighlightedItem=  'The PIN number that is highlighted at startup.
  105.     CommandMaxLength=      'Commandline maximum Length
  106.     CommandLineColor=      'Commandline maximum Length
  107.     RumoursY=              'If you use rumours, the Y position.
  108.                            'X Position is calculated.. (Centered)
  109.  
  110.     Goodluck..
  111.  
  112. -[ HOW TO REGISTER ]---------------------------------------------------------
  113.  
  114.   This program is FREEWARE, meaning that if you register it, you are stupid.
  115.   There are no bitch messages etc.. HOWEVER, I would like to hear your
  116.   comments, hate-mail or suggestions....
  117.  
  118. -[ BUGS? ]-------------------------------------------------------------------
  119.  
  120.   Some programs may cause problems with Atlantis. This is (ofcourse!)
  121.   » NOT « a bug in Atlantis but a small "think-fault" made by other PPE
  122.   writers.
  123.  
  124.   Explanation of this ridiculous statement: Some PPE writers probably
  125.   didn't think some fool was going to write a replacement for the internal
  126.   mainmenu. But since I'm about the biggest fool around, I wrote it :)
  127.   With configurable menu items, lightbar, expert mode, rumours/taglines
  128.   (YES! This is what they call inline advertisement..)  etcetera..
  129.   But.. to the point... Some PPE's are invoked by the SHIFT-F?? keys.
  130.   And when invoked the first thing they do is a clear screen NOT saving
  131.   the current screen. You may understand the problem.. PCBoard doesn't
  132.   send a notice to the current running PPE, and on return Atlantis doesn't
  133.   know another PPE was invoked. So long for logic?
  134.  
  135.   Therefor Atlantis CAN'T know that another PPE is started.
  136.   What happens is that the current screen isn't stored by some PPE's
  137.   before it runs, therefor it doesn't restore the original screen either
  138.   and when this happens within a menu, the menu doesn't get restored :-(
  139.  
  140.   Possible Solutions:
  141.  
  142.     ■ Tell your shrink, he/she knows what to say to calm you down.
  143.     ■ Contact the author of the PPE and ask him for a patch/new version.
  144.       (Okay..I admit.. it really isn't a bug..)
  145.     ■ Decompile the PPE and do the job yourself... like I do :)
  146.  
  147.       The following example show how to decompile a PPE, add some code
  148.       to the PPE and make it work with Atlantis.
  149.       For this example I've used:
  150.        ■ PCBoard Programming Language eXtractor 1.7O (PPLX)
  151.          (c)1995 - Lone Runner / AEGiS CoRP'95
  152.        ■ Blackcat's YASSC - a marvelous Split-Screen Chatter.
  153.          released by PWA.
  154.  
  155.       NOTE:
  156.       USING THIS EXAMPLE IS COMPLETLY ILLEGAL. THE AUTHOR OF THE
  157.       ORIGINAL PPE MAY NOT BE HELD RESPONSIBLE BY ANY DAMAGE MADE
  158.       BY THE RE-COMPILED PPE. ALWAYS READ THE DISCLAIMER !!!
  159.  
  160.       Here we go:
  161.       ■ Make a backup of the CHAT.PPE file.
  162.       ■ PPLX CHAT.PPE (this will decompile CHAT.PPE to CHAT.PPX)
  163.       ■ Edit CHAT.PPX
  164.       ■ Below the declarations part, add:
  165.           INTEGER  LastX        'Variable to store the last X
  166.           INTEGER  LastY        'Variable to store the last Y
  167.       ■ A few pages below that you'll see:
  168.         :LABEL001
  169.          INT019 = 20
  170.          STRING005 = Mask_Pwd()
  171.          STRING005 = Strip(STRING005, " ")
  172.          STRING017 = PpePath() + "chat.cfg"
  173.          STRING018 = PpePath() + "sysop.cdt"
  174.          STRING019 = PpePath() + "user.cdt"
  175.       ■ Add the following code, without the '>'-characters.
  176.       >  LastX = GETX()         'Fill variabele with Current X
  177.       >  LastY = GETY()         'Fill variabele with Current Y
  178.       >  ANSIPOS 79,24
  179.       >  SAVESCRN               'So that SaveScreen saves the WHOLE screen.
  180.       ■ Some more pages down you'll see:
  181.         :LABEL007
  182.          Tokenize ReadLine(STRING017, 7)
  183.          INT012 = GetToken()
  184.          STRING014 = GetToken()
  185.          Gosub LABEL008
  186.          Gosub LABEL009
  187.          <--[ ADD CODE FROM BELOW IN HERE [-->
  188.          End
  189.       ■ And finally, add the following code BEFORE the 'End' statement
  190.         Without the '>'-characters:
  191.       >  RESTSCRN                'Restore last saved screen
  192.       >  ANSIPOS LastX, LastY    'RePosition the cursor as it was before PPE
  193.       >  LastY = GETY()          'was invoked
  194.       ■ PPLC Chat.PPX
  195.       ■ This should be about it. Sorry Blackcat for reverse-engineering your
  196.         PPE, but I  guess there are a lot of  people using your  chatter and
  197.         are dying for this information :-)
  198.  
  199. -[ AUTHOR ]------------------------------------------------------------------
  200.  
  201.   If you find bugs, have any suggestions/additions you want, or simply
  202.   want to register this PPE contact me.
  203.   (Check the Err-Tip.TXT included in this package.)
  204.  
  205.   E-Mail  : jroger@freemail.nl
  206.   IRC     : EFNet, #pinnacle
  207.  
  208. -[ TRADEMARKS ]--------------------------------------------------------------
  209.  
  210.   PCBoard is a registered trademark of Clark Development Company.
  211.   PPLX is copyright by Lone Runner / AEGiS CoRP'95.
  212.   YASSC is copyright by Blackcat.
  213.   Atlantis is copyright by Jolly Roger.
  214.   MBMS v1.0 is copyright by Jolly Roger.
  215.  
  216.  
  217. -[ GREETINGS PART ]----------------------------------------------------------
  218.  
  219.   I'd like to say hi to, in NO specific order:
  220.  
  221.   ALL People on my favourite IRC channels !!!!
  222.   (I lost counting..)
  223.  
  224. -[END OF DOCUMENTATION]-------------------------------------------------------
  225.  
  226.  
  227.